home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
User's Choice Windows CD
/
User's Choice Windows CD (CMS Software)(1993).iso
/
utility1
/
hlpdk40.zip
/
HLPDK.DOC
< prev
next >
Wrap
Text File
|
1993-04-29
|
28KB
|
593 lines
╔══════════════════════════════════════════════════════════════════════════╗
║ ║
║ ISoft D&M ║
║ POB. 5517 ║
║ Coralville IA 52241 ║
║ U.S.A ║
║ ║
╚══════════════════════════════════════════════════════════════════════════╝
*******************************************************************************
* HLPDK- Help Engine Dev. Kit : helpEng Doc V4.0 *
* LAST UPDATE - Apr. 29, 1993. (c) 1992,93 - Loewy Ron. *
*******************************************************************************
RL Help Engine.
Help Compiler, Run-Time help engine and docs.
Support for Dos & Windows.
Supported Formats :
Native, Win30, Win31, QuickHelp, THELP, TVHC, POPHELP, DESQview/X
"Write Once, Help Many!"
*******************************************************************************
* File-List *
*******************************************************************************
This package contains the following files :
HELPENG.EXE - Help Engine.
HELPC.EXE - Help Compiler.
HLPDK.DOC - This file.
HELPC.DOC - Help Compiler documentation
HELPDEMO.HDF - Demo Help Project.
2NDDEMO.HDF - Demo Help Project - file 2.
HELPDEMO.HLP - Demo Help Project file for Windows WINHELP.
HLPDK.REG - Registration file.
HLPDK.HDF - Help Development Kit hypertext help database source.
HLPDK.HDT - Help Development Kit help database file.
HLPDK.SET - Help Development Kit help database file.
HLPDKTOP.* - Help Development Kit help database files.
HLPDKLNK.* - Help Development Kit help database files.
PROGRAMS.TXT - ISoft D&M shareware products description.
*******************************************************************************
* Why Register *
*******************************************************************************
The Help Engine Development Kit (HLPDK) is a shareware product,
if you find this product valuable, please register it.
This section describes the reasons you should register.
By registering you will receive a complete discussion
of the help engine features, and many examples of usage. You will receive a
diskette with the latest HLPDK version, and DPMI (dos protected mode)
versions of the help compiler and engine!.
Your registration will help us to create the next versions of HLPDK, that
will include more options, and features, some of them might even be your
enhancement requests!.
A point to consider - If you want to create Windows Help source files,
you will have to purchase a word processor that can output RTF files,
the WORD for Windows 2.0 package, for example, is listed at around $500!.
*******************************************************************************
* What's New *
*******************************************************************************
Version 4.0
- Help Source Generation is much faster in this version, when the
target is NOT the native format, and no Report is generated.
In this case, helpC storage requirements will be much
smaller as well, because no paradox topic and link tables will
be created during the compile phase.
Please notice that if POPHELP is the target, a temporary paradox
table will still be created, during pass 1 pre-processing, pass 2
however, will be much faster than what it was before.
Compiling the hlpdk source on my 33MH 486 computer using
helpc hlpdk /w30 /r-
takes 1.76 sec. in V3.1 Vs. 5.23 sec. in V3.0.
- Added the .PARAGRAPH .. .-END-PARAGRAPH paragraph markers in the
topic text section of the .HDF language. Use this feature to
create long paragraphs that will be wrapped as one paragraph when
the help window is resized by the user. This feature is currently
supported for winHelp code generation only.
Please refer to the HELPC.DOC file for further discussion of this
text formatting feature.
- Updated To Paradox Engine 3.01.
- For easier development the .TOP and .ENDTOP commands are equivelent
to the .TOPIC and .END-TOPIC commands.
- If no data file name is given to the helpC compiler, the set name
with target specific extention is given instead of the default
name given in previous versions.
- If the help topics and link names are not specified, names that are
derived from the set name are given in this version, instead of the
default names that were given in previous versions.
- Added support for long topic names, that include spaces in them.
Please refer to the HELPC.DOC file, regarding the /ST switch.
- Added DESQview/X code generation support. Please refer to the
HELPC.DOC File for the /XD+ HELPC Switch. In order to compile
the generated source you will have to use MDVXHELP, by
Daniel J. Bodoh, that can be found in the file DVXHLP10.ZIP in
the DV-X directory on SIMTEL20, and probably some other places
on the internet, and other networks.
- When generating code to THELP source format, the helpC compiler
will issue a warning when an illegal HL link (topic) name is
found, and will automatically convert this identifier to a name
that is supported by the HL compiler.
- Added the .PCFONT command to the HDF syntax - use this command
to set the font used in the generated RTF file for WinHelp V3.x
to a terminal font. (By default a proportional font is used).
If you convert your help database that uses PC special characters,
and you want to preserve these characters in the windows version,
use this statement.
This command has no effect on targets that are different from
windows winHelp formats.
- When comiling to winhelp format, character with ordinal number
bigger than 127 will be translated using the RTF override
mechanism. The "Famous" HC31 problem is over.. . (This solution
was offered by Mr. Lars Fosdal.)
- When generating to winHelp Target, TAB characters are translated
to rtf \tab commands. For other targets no TAB translation is
performed. It is advised that you set your editor to fill spaces
when a tab is inserted.
- Added the /CS switch to the helpC compiler. Using this switch
topics and links can be set to be case sensative. It is not advised
to use this switch, unless you want to create lower case indexes
in a help engine such as POPHELP or THELP. Please notice - setting
this switch to ON (+) can break help databases that used to compile
fine. Use With Care!. (By default case sensativity is set to off).
- The HELPENG help engine can now handle topics with up to 500 lines,
vs. 125 in the previous version.
*******************************************************************************
* Introduction *
*******************************************************************************
The Help Engine Development Kit is a system that allows you to create
hyper-text database help systems with topics and hot links, using a simple
text editor and the help compiler.
The help databases can be distributed (free of charge) with the HELPENG
help engine display program.
If you own the Paradox Engine you can use the help databases with your
own programs.
The helpC compiler that is part of this development kit includes the
ability to create Windows Help source files from the same source the
dos help sources are created!. Write your help once, and create help
databases for Dos, Windows and DESQview/X !
Contact ISoft D&M if you want to purchase the WINTEXT UI library for
Turbo Pascal programs, and use the help engine window in your pascal
programs.
*******************************************************************************
* Setup *
*******************************************************************************
Copy the files in this package to a directory of your choice.
*******************************************************************************
* Quick Start *
*******************************************************************************
From the command line enter HELPC HELPDEMO to compile the demo help database.
After the compilation process is ended, enter HELPENG HELPDEMO to browse the
demo help database.
If you want to compile for windows :
from the command line enter HELPC HELPDEMO /W31
and after that HC31 HELPDEMO
(HC31 is the Microsoft Help Compiler)
from windows, open the HELPDEMO.HLP file from the windows help engine.
(Notice - if you do not have the HC help compiler from windows, we have
included a compiled version of HELPDEMO (HELPDEMO.HLP) so you will be
able to feel the quality of the output that can be generated, and decide
if you want to purchase the HC31 program (Included with the SDK, BC++,
TPW, BP and probably some other packages), or download it from one of the
sites Microsoft had uploaded it to).
If you use windows 3.0, or want your help file to be compatible with
winHelp 3.0 use :
HELPC /W30 HELPDEMO
HC HELPDEMO
To compile for THELP use :
HELPC /TH+ HELPDEMO
HL -x -e100 -p -i -oHELPDEMO.TPH HELPDEMO.HL
To compile for QuickHelp :
HELPC /QH+ HELPDEMO
HELPMAKE -e15 -oHELPDEMO.QH HELPDEMO.SRC
To compile for TVHC :
HELPC /TV+ HELPDEMO
TVHC HELPDEMO.TXT
To compile for POPHELP :
HELPC /PH+ HELPDEMO
MAKEHELP /Q HELPDEMO
To compile for DESQview/X
HELPC /XD+ HELPDEMO
MDVXHELP HELPDEMO.HLP @HELPDEMO.LST
COPY HELPDEMO.HLP d:\DVX\HELP
*******************************************************************************
* Operation *
*******************************************************************************
To start the help engine program enter HELPENG on the command line, and
choose the help database you want to view from the list box. Use the Tab key
to cycle between hot-link words, and press Enter to go to that link.
If you know the name of the SET file of the database you want to activate, you
can enter it on the command line, and the help engine will display it.
If you have a mouse, you can use it to point at the hi-lighted links, and
activate them by pressing the left mouse button.
Press the ALT-T key combination to choose from a list of TOPICS in the
database, Press ALT-B to go back to the previous displayed TOPIC, Press
ALT-X to exit the help engine.
The exit command can be given by pressing the right mouse button.
To create a new help database please refer to the HELPC documentation
file.
*******************************************************************************
* Warranty *
*******************************************************************************
There is no warranty what so ever, The package is supplied as is,
The distributor (ISoft D&M), or the author (Loewy Ron), are not,
and will not be responsible for any damages, lost profits,
or inconveniences caused by the use, or inability to use this package.
The use of the program is at your own risk.
By using (or attempting to use) the package you agree to this.
*******************************************************************************
* General *
*******************************************************************************
HLPDK is distributed by ISoft D&M, P.O.B. 5517 CORALVILLE IA 52241, U.S.A.
HLPDK is (c) copyrighted by Loewy Ron, 1992, 93.
HLPDK is a shareware program, please register your copy.
To register your copy of HLPDK please refer to the supplied
HLPDK.REG file.
Other programs distributed by ISoft D&M are described in the supplied
PROGRAMS.TXT file.
*******************************************************************************
* Contact *
*******************************************************************************
Please contact :
ISoft D&M,
P.O.B 5517
Coralville IA 52241,
U.S.A
To contact the author directly :
Contact : Loewy Ron,
9 Haneveem st.
Herzeliya, 46465
ISRAEL.
e-mail address : CompuServe - 100274,162
*******************************************************************************
* Trouble Shooting *
*******************************************************************************
If you receive some kind of an error message while using the help development
kit please refer to this section.
tableOps: xxxx error message :
This message is generated by the Paradox Engine if an internal error occurs,
if you receive a message that is not understood (e.g. Table is busy),
please try one of the following :
1. Try running the Help Compiler or the Help Engine with another input and
notice if the problem exists, if it does, turn to the next entry,
otherwise try to see what the difference between the inputs is.
2. Check your free memory, try to move some TSR's from memory, or use the
protected mode compiler/engine available with the registered version.
3. Check if you have loaded dos SHARE program, it is advised to use SHARE
with programs that use the Paradox Engine. If you receive a table busy
error, try to see if you have another program that uses the same table
in another session (Windows/DESQview etc..).
4. PANIC - Please contact the distibuter/author for additional help.
Microsoft's HC31 help compiler will generate a error in RTF file error :
1. Re-compile using HELPC 4.0+. This should solve the problem, if the problem
still exists - please try steps 2 and 3, and notify the author.
2. Use a binary disk editor to look at the character at the position x - 1
in the RTF file (where x is the error position reported by HC31).
3. Try to replace that charqacter from a special PC oem character to a
"standard" ascii character (such as *). If the problem still occurs,
please contact ISoft D&M/The author, otherwise - you probably came
accross a character that HC31 can not handle. In that case - try using
HC300b (the one that generates winHelp 3.0 format), or delete these
characters from your source HDF file.
Borland's HL help linker will generate a FE02: Out Of Memory error :
1. Re-compile using HELPC V3.0+, to include ;INDEX directives after the
screen's definitions.
Borland's HL help linker will complain about undefined context numbers.
1. You probably have a contents.h file in the current directory, that hl
tries to use to bind the help topics to Borland's IDE on-line help,
try renaming this file, and re-compile with HL.
We have encountered some users that ran into problems, because they did
not use the dos SHARE program. We advise that you will always load the
SHARE program in your AUTOEXEC.BAT file.
*******************************************************************************
* History *
*******************************************************************************
Version 1.0
- First Version, Written for TXS V3.0 help system,
and generalized.
Version 1.1
- The Help Engine ALT-X (EXIT) command restores the screen
upon termination.
- Added /R switch for the helpC help compiler.
- From this version the helpC compiler can generate source
files for the Microsoft help compiler (HC) from the
SAME source .HDF). If the /w+ switch is specified,
the helpC compiler will create a .HPJ and .RTF files
to create the Windows .HLP file.
- Includes a compiled version of the help demo database for
Windows WINHELP program. (View this if you do not have the
Microsoft HC Windows Help Compiler, to see the output that
can be generated with the helpC compiler, as a source to the
HC compiler.
Version 1.2
- Windows RTF files will now display special characters ({, }, \),
by prefixing them with the RTF over-ride character (\), when the
/W+ switch is given to the helpC compiler.
- helpC and helpEng were converted from TP6 to BP7.
- The help engine and help compiler use the Paradox Engine V3.0 from
this release. (No need to keep your old PXENGINE.OVL file anymore).
- Added the /W30 and /W31 switches to the helpC compiler. Use these
switches to set the output for the HC30 and HC31 Microsoft Windows
help compilers.
- The help window scroll bars are are shown after a link is executed.
(A bug fix).
- Added "Trouble Shooting" section to this document.
- helpC and helpEng have DPMI versions to handle large projects.
(Available only with the registered version).
Version 2.0
- The help engine will display a new topic from the first line, and
not from the place that shows the current active link.
- The help window in the help engine program can now be scrolled to
regions of the help topic, that do not include the current, or
any link.
- A mouse click on a link, when the left-column is not 1 is recognized
as it should be.
- The helpC help compiler will recognize .TOPIC and .END-TOPIC as
topic declaration keywords, as well as the .ENTRY and .END-ENTRY
that were used until this version.
- The help topic table has a new field in it - the title field, using
this field you can specify the title of the help window, when it
displays a topic. Because of this field, databases created with
older versions of the help development kit will have to be
re-compiled. (Please refer to HELPC.DOC).
- The helpC help compiler will accept .TITLE keyword after the
.ENTRY (.TOPIC) line, to define a title to a topic window.
- Added support for Microsoft Quick Help sources, and Borland THELP
sources generation.
- The helpC compiler will translate ~~ in the source help definition
into a ~ sign in the help database. (In versions 1.x you could not
include the ~ sign in your help output text).
- The help engine will except ALT-B as the go-back short-cut - to
display the previous help screen.
Version 2.1
- I received several complaints that the HC31.EXE winHelp help compiler
does not work, and aborts at a specific place (byte 0x122) on the
RTF file created by running HELPC /W31 HLPDK. It seems that for some
reason the HC31 compiler is not able to process all of the ascii
characters. The ╔ character that appeared in byte offset 0x121
caused the HC31 compiler to abort. I do not know why this is
a problem, I will try to investigate, and if I can not come with an
answer - I will try to contact microsoft (hey folks - they wrote it)
and find out. In the mean while - the HLPDK.HDF file provided with
this package - can be compiled by the HC31 compiler.
- I have noticed that not all of the .HL files generated for THELP
users work. I must admit I can not find the reason, I will continue
to investigate. I must admit it looks like a problem with the HL
docuimentation I have. In the mean while - please continue to
investigate the help development kit, and inform me of any
other problems you face with it.
- You can contact me (NEW NEW NEW) on my NEW (did I say that ..)
Compuserve Address : 100274,162
from internet that is : 100274.162@compuserve.com .
Please send any enhancement requests, bug reports or other things -
I'm currently in the process of planning the next major version,
and any input will be helpful.
- QH (quickHelp) files will now display backslash characters that
appear in the source file, by pre-fixing them with the over-ride
character (\), when the /QH+ switch is given to the helpC compiler.
- QH (quickHelp) links will now be visible, even when they are not
hi-lighted. These links will appear in BOLD face, by using the \b
bold source command.
- For people interested in the HC help compiler - If you do not have
it in your development package (I was told that visual basic
standard edition does not include it), you can download the
3.0b version from CICA, in the winword directory.
- NEW - Added TVHC Support - Use the /TV+ switch to create TVHC sources,
that you can compile using your version of TVHC (PASCAL or C++).
Version 3.0
- The THELP code generation was improved to support HL v6.10 that
comes as part of the Borland Pascal Open Architecture package.
Because of this change the following things should be noted :
1. The source screens inlude a ;INDEX directive, so HL will
not abort on FE02: Out Of Memory errors.
2. A new dummy screen that is needed for Borland Pascal IDE
is generated as the first screen in the soure .HL code.
You MUST compile the generate code using HL's -e switch,
specifing a number which is bigger then 1. HL will always
issue one error message - that screen DUMMY is not referenced,
this error should be ignored, the resulting .TPH/.TCH file
will be a valid THELP and IDE help file.
3. HL V6.0 should still work, with better results, becasue the
Out Of Memory errors should be eliminated as well. (Do remeber
to use the -e switch with a value > 1).
- The .TITLE directive cause titles to be generated for THELP
source now.
- Added the .LINKCOLOR and .LINKHIGH commands in the Help Definition
File (.HDF) - that set the color of links in "normal" and
hi-lighted states. This feature is relevant only when compiling
to native paradox engine (Help Engine) format.
- Added the .INCLUDE commands to the .HDF specifications. Use this
help definition file command to create complex help projects that
are composed from multiple .HDF source files.
- The helpC program will abort with an error message if no .end-topic
command was supplied to the last topic in a .HDF file.
- Added the ALT-T Topic Index command to the Help Engine. Use ALT-T
to display and choose from a list of all the topics in the help
database. For ease of use the topics are displayed with their titles.
- Upon user's request - The ALT-X command will not have to be confirmed
by a TAB in order to exit the Help Engine.
- Added support for the Search facility of WinHelp V3.x. From now on
the search button of windows help engine will display the list of
topic titles available in the help database.
- Added the .FIXEDFONT command to the HDF syntax - use this command
to set the font used in the generated RTF file for WinHelp V3.x
to a fixed font. (By default a proportional font is used). If you
find that your help databases are not aligned after they are
converted to winHelp format, use this command and re-compile.
This command has no effect on targets that are different from
windows winHelp formats.
- The helpC compiler was converted to perform multiple passes on the
input data, if these passes are needed.
- The maximum topic name length was expanded to 40 characters - this
means that V2.x help databases will have to be re-compiled for
this version.
- Maximum Text displayed for a link was expanded to 60 characters.
- The ALT-B HelpEng command has been enhanced to return to the position
viewed last.
- Added POPHELP Source Generation. Use the helpC /PH+ parameter to
create source that can be used by TurboPower Software's makehelp
program - to create a pophelp .HLP file.
- When generating code to winHelp source format, the helpC compiler
will issue a warning when an illegal HC link (topic) name is
found, and will automatically convert this identifier to a name
that is supported by the HC compilers.
*******************************************************************************
* Credits *
*******************************************************************************
HELPENG, HELPC were written using Turbo Pascal 6.0, and Borland Pascal 7.0,
Paradox Engine 2.0, and Paradox Engine 3.0, 3.01.
(Trademarks of Borland International).
Windows, Microsoft, HC and Quick Help are trademarks or copyrights
of Microsoft Corp.
The HELPENG program was written using the WINTEXT UI library,
(c) 1991,93 Loewy Ron.
THELP, HL and TVHC are Trademarks or copyrights Borland International.
TVHC support, and other ideas were suggested by MunLeong Chan.
POPHELP is a copyright of TurboPower Software.
Parts of the Help Engine were generated using Ron Loewy's WTGEN CASE code
generator.
Yaniv Golan helped me with beta-testing and debugging.
John Murphy notified me of the paragraph formtting difficulties that
lead to the .PARAGRAPH .END-PARAGRAPH formatting capabilities.
DESQview/X is a trademark of Quarterdeck Office Systems.
MDVXHELP is a copyright (1992) of Daniel J. Bodoh. I have used his
excelent documentation of DESQview/X help format to generate code
to this environment.
The HC31 problem with characters with ordinal values biggen than 127
was solved thanks to Mr. Lars Fosdal of Norway.